home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / pktz_011.arc / PKTIZE.DOC < prev    next >
Text File  |  1991-06-19  |  13KB  |  532 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.         PKTize version 0.11
  29.  
  30.         User guide
  31.  
  32.         A Generic .PKT file generation utility
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                Table of contents
  64.  
  65.         1 Legal notice  . . . . . . . . . . . . . . . . . . . . .     1
  66.  
  67.         2 Introduction  . . . . . . . . . . . . . . . . . . . . .     2
  68.  
  69.         3 The program . . . . . . . . . . . . . . . . . . . . . .     3
  70.             3.1 Command line options  . . . . . . . . . . . . . .     3
  71.                 /t<DestAddr>  . . . . . . . . . . . . . . . . . .     3
  72.                 /i<Input> . . . . . . . . . . . . . . . . . . . .     3
  73.                 /d<Path>  . . . . . . . . . . . . . . . . . . . .     3
  74.                 /s<Subject> . . . . . . . . . . . . . . . . . . .     3
  75.                 /e<User>  . . . . . . . . . . . . . . . . . . . .     3
  76.                 /r  . . . . . . . . . . . . . . . . . . . . . . .     4
  77.                 /a<2-10>  . . . . . . . . . . . . . . . . . . . .     4
  78.                 /n<2-10>  . . . . . . . . . . . . . . . . . . . .     4
  79.                 /m[-] . . . . . . . . . . . . . . . . . . . . . .     4
  80.                 /ni . . . . . . . . . . . . . . . . . . . . . . .     4
  81.                 /np . . . . . . . . . . . . . . . . . . . . . . .     5
  82.                 /ns . . . . . . . . . . . . . . . . . . . . . . .     5
  83.                 /b<p|c|f|k|h>[-]  . . . . . . . . . . . . . . . .     5
  84.  
  85.         4 The configuration file  . . . . . . . . . . . . . . . .     6
  86.                 AKA <address> . . . . . . . . . . . . . . . . . .     6
  87.                 NAME <username> . . . . . . . . . . . . . . . . .     6
  88.                 MSGBITS <msgbit>  . . . . . . . . . . . . . . . .     6
  89.                 PASSWORD <address> <password> . . . . . . . . . .     6
  90.                 OUTPUT <directory>  . . . . . . . . . . . . . . .     6
  91.                 MULTIPLEMSG . . . . . . . . . . . . . . . . . . .     7
  92.  
  93.         5 Input data handling . . . . . . . . . . . . . . . . . .     7
  94.  
  95.         6 Revisions . . . . . . . . . . . . . . . . . . . . . . .     7
  96.  
  97.         7 Support . . . . . . . . . . . . . . . . . . . . . . . .     7
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.                                PKTize User Guide
  123.  
  124.         1 Legal notice
  125.  
  126.         PKTize is protected by applicable copyright laws and
  127.         international treaty provisions. PKTize is provided as is,
  128.         without warranty of any kind, either expressed or implied.
  129.         Joaquim H. Homrighausen only guarantees that PKTize will
  130.         occupy disk space.
  131.  
  132.         In no event shall Joaquim H. Homrighausen be liable to you or
  133.         anyone else for any damages, including any lost profits, lost
  134.         savings or other incidental or consequential damages arising
  135.         out of the use or inability to use PKTize.
  136.  
  137.         PKTize is yours to keep. It is not public domain, shareware or
  138.         freeware, it is simply free of charge. You can use it provided
  139.         you do not use it within a commercial environment. It doesn't
  140.         matter if you are making money by using it or not, if you are
  141.         using it within commercial walls, you must obtain written
  142.         permission from Joaquim H. Homrighausen to use PKTize.
  143.  
  144.         You may freely distribute and copy PKTize provided no fee is
  145.         charged (this includes trading) and the PKTize archive
  146.         contains unmodified copies of PKTIZE.EXE, PKTIZE.DOC,
  147.         PKTIZE.HIS, and PKTIZE.CFG.
  148.  
  149.         All Joaquim H. Homrighausen products are trademarks or
  150.         registered trademarks of Joaquim H. Homrighausen. Other brand
  151.         and product names are trademarks or registered trademarks of
  152.         their respective holders.
  153.  
  154.         Copyright 1991 Joaquim H. Homrighausen. All rights reserved.
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.                                        1
  176.  
  177.  
  178.  
  179.  
  180.  
  181.                                PKTize User Guide
  182.  
  183.         2 Introduction
  184.  
  185.         PKTize is a utility which will allow you to create FidoNet
  186.         compatible mail packets. You do not have to know what is
  187.         involved nor do you have to understand the binary format of a
  188.         mail packet in order to use PKTize; you simply have to provide
  189.         the required parameters. PKTize creates 100% FTSC-001
  190.         compatible mail packets; it utilizes the FSC-039
  191.         specifications to provide a more complete addressing scheme
  192.         than that found in FTSC-001.
  193.  
  194.         I wrote PKTize because I frequently have to test code that
  195.         unpack mail packets and I was getting sick of creating test
  196.         messages, packing them using a FidoNet mailer or conference
  197.         mail package, etc. Another obvious use is to provide a simple
  198.         mechanism for programs, running as a service request under
  199.         mailers, to generate mail packets which will be unpacked to
  200.         messages at the remote site instead of having to send several
  201.         small ASCII (text) files.
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.                                        2
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                                PKTize User Guide
  241.  
  242.         3 The program
  243.  
  244.         PKTize can be executed from the DOS command line, by another
  245.         program, and/or from a DOS batch (.BAT) file. PKTize requires
  246.         somewhere between 25 and 35KB. It will return two different
  247.         errorlevels: 0=OK and 1=Failure to complete. Few errors are
  248.         possible; short of running out of diskspace and invalid or
  249.         missing input files, PKTize should operate as instructed to.
  250.  
  251.             3.1 Command line options
  252.  
  253.             /t<DestAddr>
  254.  
  255.             The address to which the mail packet and the packed
  256.             messages should be addressed. A fully qualified
  257.             FidoNet-style address (ie. 2:201/329) is required as
  258.             no default address handling exists.
  259.  
  260.             /i<Input>
  261.  
  262.             One or more names of files that should be used to
  263.             generate the message text. This can optionally be the
  264.             name of a single response file in the format
  265.             @filename.ext. The response file must contain one
  266.             filename per line. If more than one name is specified,
  267.             they should be separated by a comma (eg. -Ifil1,fil2).
  268.  
  269.             /d<Path>
  270.  
  271.             Used to override the default destination (output)
  272.             directory for PKTize. Unless this is used, the
  273.             directory specified after the OUTPUT option in
  274.             PKTIZE.CFG will be used for the created mail packets.
  275.  
  276.             /s<Subject>
  277.  
  278.             The text to be placed in the "Re:" (Subject) field of
  279.             the generated message(s). The default text is a single
  280.             dot (.). Use the underscore (_) character, instead of
  281.             spaces, to separate words (eg. -SHi_there).
  282.  
  283.             /e<User>
  284.  
  285.             The text to be placed in the "To:" field of the
  286.             generated message(s). The default text is "SysOp". Use
  287.             the underscore (_) character, instead of spaces, to
  288.             separate words (eg. -EJohn_Doe).
  289.  
  290.  
  291.  
  292.  
  293.                                        3
  294.  
  295.  
  296.  
  297.  
  298.  
  299.                                PKTize User Guide
  300.  
  301.             /r
  302.  
  303.             Specifies that you want PKTize to remove the input
  304.             files after it has processed them. Note that the
  305.             file(s) will be removed even if they could not be
  306.             successfully opened/processed. The response file (if
  307.             any) will not be removed by using this option.
  308.  
  309.             /a<2-10>
  310.  
  311.             Use the specified AKA (Also Known As) address rather
  312.             than the primary address as the originating address.
  313.  
  314.             /n<2-10>
  315.  
  316.             Use the specified NAME slot (in PKTIZE.CFG) rather
  317.             than the primary name in the "By:" field of messages.
  318.  
  319.             /m[-]
  320.  
  321.             Unless the MULTIPLEMSG option has been enabled in
  322.             PKTIZE.CFG, the default behavior of PKTize is to
  323.             'bundle' all input files into one message. By using
  324.             MULTIPLEMSG in PKTIZE.CFG or -M on the command line,
  325.             you tell PKTize to generate one message per input
  326.             file. Note that this does not affect the number of
  327.             mail packets that PKTize will create (which is always
  328.             one).
  329.  
  330.             /ni
  331.  
  332.             PKTize will create ^aINTL information if:
  333.  
  334.                 *   The destination address' zone is
  335.                     different than the originating (yours)
  336.                     address' zone.
  337.  
  338.                 *   If you have specified another AKA than
  339.                     the primary address (-A<nn>).
  340.  
  341.             Only use this option if you do not want any ^aINTL
  342.             information in the message(s).
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.                                        4
  353.  
  354.  
  355.  
  356.  
  357.  
  358.                                PKTize User Guide
  359.  
  360.             /np
  361.  
  362.             PKTize will create extended point information if the
  363.             originating (^aFMPT) address contains a point (other
  364.             than zero) or if the destination address (^aTOPT)
  365.             contains a point (other than zero). Use this option if
  366.             you do not want PKTize to insert extended point
  367.             information even if these conditions are met.
  368.  
  369.             /ns
  370.  
  371.             Normally, PKTize will remove all <SoftCR> characters
  372.             (ASCII 141) from the input data. This may, however,
  373.             not be desireable in all situations. By using -NS, you
  374.             force PKTize to retain any <SoftCR> character in the
  375.             input data.
  376.  
  377.             /b<p|c|f|k|h>[-]
  378.  
  379.             Used to override the MSGBITS option in PKTIZE.CFG.
  380.             P=Private, C=Crash, F=File, K=Kill/Sent, and H=Hold.
  381.             Only one attribute may be specified per -B option. If
  382.             you want to set/reset more than one attribute bit, you
  383.             must use multiple -B options.
  384.  
  385.         NOTE: Both the / (slash) and - (dash) characters are legal
  386.         command line switch characters.
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.                                        5
  412.  
  413.  
  414.  
  415.  
  416.  
  417.                                PKTize User Guide
  418.  
  419.         4 The configuration file
  420.  
  421.         PKTize retrieves its default options from a file called
  422.         PKTIZE.CFG. This file has to reside in the same directory as
  423.         PKTIZE.EXE. A sample configuration file is included in the
  424.         distribution archive.
  425.  
  426.         AKA <address>
  427.  
  428.             Defines a network address in FTSC-001 format
  429.             'z:n/n.p@d' where '@d' (domain) is optional. A maximum
  430.             of 10 AKA statements are supported.
  431.  
  432.         NAME <username>
  433.  
  434.             Defines a username to be used in the "By:" field of a
  435.             message. Use the underscore (_) character, instead of
  436.             spaces, to separate words. A maximum of 10 NAME
  437.             statements are supported.
  438.  
  439.         MSGBITS <msgbit>
  440.  
  441.             Defines a message attribute bit as part of the default
  442.             message attribute. This can be overriden by the -B
  443.             command line switch. Allowed bits are PRIVATE,
  444.             KILL/SENT, CRASH, HOLD, and FILE. Only one bit may be
  445.             specified per MSGBITS line. If you want to set more
  446.             than one bit, you must use multiple MSGBITS lines.
  447.  
  448.         PASSWORD <address> <password>
  449.  
  450.             Defines a packet level password for the specified
  451.             system. Whenever PKTize generates a packet for a
  452.             system listed in a PASSWORD line in PKTIZE.CFG, the
  453.             specified password will automatically be inserted into
  454.             the packet header. A maximum of 50 PASSWORD lines are
  455.             allowed and a maximum of eight characters per
  456.             password. Passwords are case sensitive. Use the
  457.             underscore (_) character, instead of spaces, to
  458.             separate words.
  459.  
  460.         OUTPUT <directory>
  461.  
  462.             Defines the default output directory to which PKTize
  463.             will write the generated mail packets. This can be
  464.             overriden with the -D command line switch.
  465.  
  466.  
  467.  
  468.  
  469.  
  470.                                        6
  471.  
  472.  
  473.  
  474.  
  475.  
  476.                                PKTize User Guide
  477.  
  478.         MULTIPLEMSG
  479.  
  480.             Unless this option is used, the default behavior of
  481.             PKTize is to 'bundle' all input files into one
  482.             message. By using this option or -M on the command
  483.             line, you tell PKTize to generate one message per
  484.             input file. Note that this does not affect the number
  485.             of mail packets that PKTize will create (which is
  486.             always one).
  487.  
  488.         5 Input data handling
  489.  
  490.         PKTize will strip all characters in the range ASCII 0 through
  491.         ASCII 31 except ASCII 13, which is a <CR>, from the input
  492.         data. PKTize will by default also strip <SoftCR> (ASCII 141)
  493.         characters, this can, however, be overriden with the -NS
  494.         command line switch as previously explained.
  495.  
  496.         6 Revisions
  497.  
  498.         The file PKTIZE.HIS contains important notes and revisions.
  499.  
  500.         7 Support
  501.  
  502.         While there is no specific technical support available for
  503.         this program, you can always send me a message if you are
  504.         having problems and/or want to make suggestions or comments.
  505.  
  506.         You can send mail to me on:
  507.  
  508.             2:270/17@fidonet
  509.             joho@fido.rmi.de
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.                                        7
  530.  
  531.  
  532.